<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: Bloomberg::quantum::FutureJoiner&lt; T &gt; Class Template Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d3/dc6/classBloomberg_1_1quantum_1_1FutureJoiner-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Bloomberg::quantum::FutureJoiner&lt; T &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Utility class that joins N futures into a single one.  
 <a href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../da/dab/quantum__future__joiner_8h_source.html">quantum_future_joiner.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa6e964d714d1dc39d34986229f045a4c"><td class="memTemplParams" colspan="2">template&lt;class DISPATCHER , class  = std::enable_if_t&lt;std::is_same&lt;typename DISPATCHER::ContextTag,ThreadContextTag&gt;::value&gt;&gt; </td></tr>
<tr class="memitem:aa6e964d714d1dc39d34986229f045a4c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr</a>&lt; std::vector&lt; T &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html#aa6e964d714d1dc39d34986229f045a4c">operator()</a> (DISPATCHER &amp;dispatcher, std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#aa26dcdfb6c3930c1cd2b4000d8711f4c">ThreadContextPtr</a>&lt; T &gt;&gt; &amp;&amp;futures)</td></tr>
<tr class="memdesc:aa6e964d714d1dc39d34986229f045a4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join N thread futures.  <a href="#aa6e964d714d1dc39d34986229f045a4c">More...</a><br /></td></tr>
<tr class="separator:aa6e964d714d1dc39d34986229f045a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bdf8e74fc9d7eda10a66f19d91983ae"><td class="memTemplParams" colspan="2">template&lt;class DISPATCHER , class  = std::enable_if_t&lt;std::is_same&lt;typename DISPATCHER::ContextTag,ThreadContextTag&gt;::value&gt;&gt; </td></tr>
<tr class="memitem:a6bdf8e74fc9d7eda10a66f19d91983ae"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr</a>&lt; std::vector&lt; T &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html#a6bdf8e74fc9d7eda10a66f19d91983ae">operator()</a> (DISPATCHER &amp;dispatcher, std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr</a>&lt; T &gt;&gt; &amp;&amp;futures)</td></tr>
<tr class="separator:a6bdf8e74fc9d7eda10a66f19d91983ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2a577ca59e1e0a3a0f341167fb5b914"><td class="memTemplParams" colspan="2">template&lt;class DISPATCHER , class  = std::enable_if_t&lt;std::is_same&lt;typename DISPATCHER::ContextTag,CoroContextTag&gt;::value&gt;&gt; </td></tr>
<tr class="memitem:af2a577ca59e1e0a3a0f341167fb5b914"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a8cf6f8fd7d169988428556468b333fe1">CoroContextPtr</a>&lt; std::vector&lt; T &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html#af2a577ca59e1e0a3a0f341167fb5b914">operator()</a> (DISPATCHER &amp;dispatcher, std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a8cf6f8fd7d169988428556468b333fe1">CoroContextPtr</a>&lt; T &gt;&gt; &amp;&amp;futures)</td></tr>
<tr class="separator:af2a577ca59e1e0a3a0f341167fb5b914"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cbe17a70f46d5345e230f7c5a1a493c"><td class="memTemplParams" colspan="2">template&lt;class DISPATCHER , class  = std::enable_if_t&lt;std::is_same&lt;typename DISPATCHER::ContextTag,CoroContextTag&gt;::value&gt;&gt; </td></tr>
<tr class="memitem:a0cbe17a70f46d5345e230f7c5a1a493c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a8cf6f8fd7d169988428556468b333fe1">CoroContextPtr</a>&lt; std::vector&lt; T &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html#a0cbe17a70f46d5345e230f7c5a1a493c">operator()</a> (DISPATCHER &amp;dispatcher, std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a294434a555befbec5230f5ff03944878">CoroFuturePtr</a>&lt; T &gt;&gt; &amp;&amp;futures)</td></tr>
<tr class="separator:a0cbe17a70f46d5345e230f7c5a1a493c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class Bloomberg::quantum::FutureJoiner&lt; T &gt;</h3>

<p>Utility class that joins N futures into a single one. </p>
<p>Instead of waiting for N futures to complete, the user can join them and wait on a single future which returns N values. </p><dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>The type returned by the future. </td></tr>
  </table>
  </dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa6e964d714d1dc39d34986229f045a4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6e964d714d1dc39d34986229f045a4c">&#9670;&nbsp;</a></span>operator()() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;class DISPATCHER , class &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr</a>&lt; std::vector&lt; T &gt; &gt; <a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html">Bloomberg::quantum::FutureJoiner</a>&lt; T &gt;::operator() </td>
          <td>(</td>
          <td class="paramtype">DISPATCHER &amp;&#160;</td>
          <td class="paramname"><em>dispatcher</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#aa26dcdfb6c3930c1cd2b4000d8711f4c">ThreadContextPtr</a>&lt; T &gt;&gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>futures</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Join N thread futures. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">futures</td><td>A vector of thread futures of type T. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A joined future to wait on. </dd></dl>

</div>
</div>
<a id="a6bdf8e74fc9d7eda10a66f19d91983ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bdf8e74fc9d7eda10a66f19d91983ae">&#9670;&nbsp;</a></span>operator()() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;class DISPATCHER , class &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr</a>&lt; std::vector&lt; T &gt; &gt; <a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html">Bloomberg::quantum::FutureJoiner</a>&lt; T &gt;::operator() </td>
          <td>(</td>
          <td class="paramtype">DISPATCHER &amp;&#160;</td>
          <td class="paramname"><em>dispatcher</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a742e0d39218b80ae60f30d47ae58bbc9">ThreadFuturePtr</a>&lt; T &gt;&gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>futures</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="af2a577ca59e1e0a3a0f341167fb5b914"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2a577ca59e1e0a3a0f341167fb5b914">&#9670;&nbsp;</a></span>operator()() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;class DISPATCHER , class &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a8cf6f8fd7d169988428556468b333fe1">CoroContextPtr</a>&lt; std::vector&lt; T &gt; &gt; <a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html">Bloomberg::quantum::FutureJoiner</a>&lt; T &gt;::operator() </td>
          <td>(</td>
          <td class="paramtype">DISPATCHER &amp;&#160;</td>
          <td class="paramname"><em>dispatcher</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a8cf6f8fd7d169988428556468b333fe1">CoroContextPtr</a>&lt; T &gt;&gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>futures</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a0cbe17a70f46d5345e230f7c5a1a493c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cbe17a70f46d5345e230f7c5a1a493c">&#9670;&nbsp;</a></span>operator()() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;class DISPATCHER , class &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a8cf6f8fd7d169988428556468b333fe1">CoroContextPtr</a>&lt; std::vector&lt; T &gt; &gt; <a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html">Bloomberg::quantum::FutureJoiner</a>&lt; T &gt;::operator() </td>
          <td>(</td>
          <td class="paramtype">DISPATCHER &amp;&#160;</td>
          <td class="paramname"><em>dispatcher</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a294434a555befbec5230f5ff03944878">CoroFuturePtr</a>&lt; T &gt;&gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>futures</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></li><li class="navelem"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">quantum</a></li><li class="navelem"><a class="el" href="../../dc/d63/classBloomberg_1_1quantum_1_1FutureJoiner.html">FutureJoiner</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
